//
// FPlayAndroid is distributed under the FreeBSD License
//
// Copyright (c) 2013-2014, Carlos Rafael Gimenes das Neves
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.
//
// https://github.com/carlosrafaelgn/FPlayAndroid
//
package br.com.carlosrafaelgn.fplay.plugin;

@SuppressWarnings("unused")
public interface FPlayPlugin {
	interface Observer {
		int message(int message, int arg1, int arg2, Object obj);
	}

	// When creating a plugin, the most important detail:
	// add fplayplugin.jar as provided not as compile (by doing so all
	// the interfaces and classes are not copied to the destination apk)
	//
	// https://stackoverflow.com/questions/28472785/compile-provided-apk-android-dependency-scope
	//
	// provided fileTree(dir: 'libs', include: ['*.jar'])

	int API_VERSION = 1;

	int TYPE_VISUALIZER = 1;
	int TYPE_DECODER = 2;
	int TYPE_BACKGROUND_PROCESS = 3;

	int getApiVersion();
	int getPluginVersion();
	int getPluginType();

	void init(Object pluginContext, FPlay fplay);
	void destroy();

	void setObserver(Observer observer);

	void load();
	void unload();

	int message(int message, int arg1, int arg2, Object obj);
}
